Add EIP-5976: Handbook for EIP Authors #5976

xinbenlv · 2022-11-15T15:42:47Z

When opening a pull request to submit a new EIP, please use the suggested template: https://github.com/ethereum/EIPs/blob/master/eip-template.md

We have a GitHub bot that automatically merges some PRs. It will merge yours immediately if certain criteria are met:

The PR edits only existing draft PRs.
The build passes.
Your GitHub username or email address is listed in the 'author' header of all affected PRs, inside .
If matching on email address, the email address is the one publicly listed on your GitHub profile.

eth-bot · 2022-11-15T15:43:37Z

Hi! I'm a bot, and I wanted to automerge your PR, but couldn't because of the following issue(s):

(fail) .github/workflows/ci.yml

classification
`ambiguous`

'.github/workflows/ci.yml' must be in eip-###.md format; this error will be overwritten upon relevant editor approval

(pass) eip-5976.md

classification
`updateEIP`

passed!

lightclient · 2022-11-15T18:32:57Z

This is already in the EIP template?

xinbenlv · 2022-11-15T18:58:39Z

This PR is not ready to review.

My intentions is to create an informational EIP not a template. I will flip to ready for review when ready.

lightclient · 2022-11-15T19:06:40Z

It would be better to only open the PR / draft once there is actually some content or explanation.

xinbenlv · 2022-11-15T19:35:19Z

Sounds good. Closing for now. Will reopen when ready

xinbenlv · 2022-11-16T02:31:53Z

@lightclient I drafted the main piece and reopen this pull request.

The motivation was that I got some good advice from you on #5875, and I want to write it down to help myself to think when authoring new opcode proposals. But in the meanwhile I realize we can use this as a handbook for other suggestions for new authors. Hence this informational EIP.

Some of the suggestions in this draft EIP are solely my personal opinion and might be wrong. Corrections and advices are greatly welcomed!

EIPS/eip-5976.md

Pandapip1 · 2022-11-16T14:02:25Z

EIPS/eip-5976.md

+## Security Considerations
+
+No security issues introduced.


Can be omitted for informational EIPs.

Tried, EIPW wouldnt let me

Can be overwritten.

Should we remove that from EIPW side?

Yes, it should. CC @SamWilsn.

Updated to remove Security Considerations

Co-authored-by: Pandapip1 <[email protected]>

EIPS/eip-5976.md

Pandapip1 · 2022-11-16T15:14:02Z

EIPS/eip-5976.md

+## Rationale
+
+Help authors better streamline the authoring and reduce review round-trip time.


Can also be omitted.

I think this is legit rationale and I lean towards keeping the Rationele unless you are against...

I am against including a rationale for this EIP, as:

This is actually motivation, not Rationale

The "design decisions" made in this EIP are exceptionally obvious and well-documented in EIP-1.

Got it. Removed, respect your opposition.

Pinging @SamWilsn for updating EIPW to exempt "Informational" track from mandating "Rationale " and "Security Considerations"

EIPS/eip-5976.md

Pandapip1

Partial review so far:

EIPS/eip-5976.md

Co-authored-by: Pandapip1 <[email protected]>

xinbenlv · 2023-01-10T16:17:53Z

EIPS/eip-5976.md

@@ -0,0 +1,63 @@
+---


Rationale and Security Considerations were suggested to be removed by Editor as deemed not applicable to this type of EIP. This will need a manual merge

You should add this to:

EIPs/.github/workflows/ci.yml

Line 119 in cf35f4c

unchecked: 1, 5069, 5757

github-actions · 2023-02-16T00:20:12Z

There has been no activity on this pull request for 2 weeks. It will be closed after 3 months of inactivity. If you would like to move this PR forward, please respond to any outstanding feedback or add a comment indicating that you have addressed all required feedback and are ready for a review.

xinbenlv · 2023-02-16T00:26:20Z

Still WIP

github-actions · 2023-03-05T00:22:41Z

There has been no activity on this pull request for 2 weeks. It will be closed after 3 months of inactivity. If you would like to move this PR forward, please respond to any outstanding feedback or add a comment indicating that you have addressed all required feedback and are ready for a review.

github-actions · 2023-04-17T00:17:22Z

This pull request was closed due to inactivity. If you are still pursuing it, feel free to reopen it and respond to any feedback or request a review in a comment.

Create a new informational EIP for author new opcode

a25099f

github-actions bot added c-new Creates a brand new proposal e-number Waiting on EIP Number assignment s-draft This EIP is a Draft labels Nov 15, 2022

xinbenlv closed this Nov 15, 2022

xinbenlv added 2 commits November 15, 2022 18:18

Draft

399a8c4

Draft

e0d0d63

xinbenlv reopened this Nov 16, 2022

github-actions bot added t-informational and removed e-number Waiting on EIP Number assignment labels Nov 16, 2022

xinbenlv marked this pull request as ready for review November 16, 2022 02:29

xinbenlv requested a review from eth-bot as a code owner November 16, 2022 02:29

xinbenlv added 2 commits November 15, 2022 18:34

Draft

1b7ef1b

Draft

cff28dc

xinbenlv changed the title ~~Create a new informational EIP for author instruction~~ Create EIP-5976: Handbook for EIP Authors Nov 16, 2022

Draft

c389b7f

Pandapip1 changed the title ~~Create EIP-5976: Handbook for EIP Authors~~ Add EIP-5976: Handbook for EIP Authors Nov 16, 2022

Pandapip1 marked this pull request as draft November 16, 2022 11:56

Pandapip1 marked this pull request as ready for review November 16, 2022 11:56

Pandapip1 reviewed Nov 16, 2022

View reviewed changes

xinbenlv and others added 3 commits November 16, 2022 06:56

Update EIPS/eip-5976.md

8cef683

Co-authored-by: Pandapip1 <[email protected]>

Update EIPS/eip-5976.md

b4aa6bd

Co-authored-by: Pandapip1 <[email protected]>

Update EIPS/eip-5976.md

9a5bc6f

Co-authored-by: Pandapip1 <[email protected]>

Pandapip1 suggested changes Nov 16, 2022

View reviewed changes

Pandapip1 and others added 5 commits November 16, 2022 10:15

Clarifications

702236a

Allow ERCs to span across interface

4ebca58

Merge

c3aae4d

Merge branch 'main' into inst

8983733

Update

f1baebe

Pandapip1 reviewed Nov 18, 2022

View reviewed changes

xinbenlv and others added 3 commits November 29, 2022 20:48

Update EIPS/eip-5976.md

a2c48a8

Co-authored-by: Pandapip1 <[email protected]>

Update EIPS/eip-5976.md

d2a109b

Co-authored-by: Pandapip1 <[email protected]>

Change heading title & make wording clearer

a329b57

xinbenlv commented Jan 10, 2023

View reviewed changes

Pandapip1 added this to the Manual Merge Queue milestone Jan 10, 2023

Add this EIP to unchecked

66a9dcc

Pandapip1 self-requested a review February 1, 2023 14:56

Pandapip1 approved these changes Feb 1, 2023

View reviewed changes

Pandapip1 removed this from the Manual Merge Queue milestone Feb 1, 2023

github-actions bot added the w-stale Waiting on activity label Feb 16, 2023

github-actions bot removed the w-stale Waiting on activity label Feb 18, 2023

github-actions bot added the w-stale Waiting on activity label Mar 5, 2023

github-actions bot closed this Apr 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add EIP-5976: Handbook for EIP Authors #5976

Add EIP-5976: Handbook for EIP Authors #5976

xinbenlv commented Nov 15, 2022

eth-bot commented Nov 15, 2022 •

edited

Loading

lightclient commented Nov 15, 2022

xinbenlv commented Nov 15, 2022 •

edited

Loading

lightclient commented Nov 15, 2022

xinbenlv commented Nov 15, 2022

xinbenlv commented Nov 16, 2022 •

edited

Loading

Pandapip1 Nov 16, 2022

xinbenlv Nov 16, 2022

Pandapip1 Nov 16, 2022

xinbenlv Nov 17, 2022

Pandapip1 Nov 17, 2022

xinbenlv Nov 17, 2022

Pandapip1 Nov 16, 2022

xinbenlv Nov 17, 2022

Pandapip1 Nov 17, 2022

xinbenlv Nov 17, 2022 •

edited

Loading

Pandapip1 left a comment

xinbenlv Jan 10, 2023 •

edited

Loading

SamWilsn Jan 25, 2023

github-actions bot commented Feb 16, 2023

xinbenlv commented Feb 16, 2023

github-actions bot commented Mar 5, 2023

github-actions bot commented Apr 17, 2023

		## Rationale

		Help authors better streamline the authoring and reduce review round-trip time.

Add EIP-5976: Handbook for EIP Authors #5976

Add EIP-5976: Handbook for EIP Authors #5976

Conversation

xinbenlv commented Nov 15, 2022

eth-bot commented Nov 15, 2022 • edited Loading

(fail) .github/workflows/ci.yml

(pass) eip-5976.md

lightclient commented Nov 15, 2022

xinbenlv commented Nov 15, 2022 • edited Loading

lightclient commented Nov 15, 2022

xinbenlv commented Nov 15, 2022

xinbenlv commented Nov 16, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xinbenlv Nov 17, 2022 • edited Loading

Choose a reason for hiding this comment

Pandapip1 left a comment

Choose a reason for hiding this comment

xinbenlv Jan 10, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Feb 16, 2023

xinbenlv commented Feb 16, 2023

github-actions bot commented Mar 5, 2023

github-actions bot commented Apr 17, 2023

eth-bot commented Nov 15, 2022 •

edited

Loading

xinbenlv commented Nov 15, 2022 •

edited

Loading

xinbenlv commented Nov 16, 2022 •

edited

Loading

xinbenlv Nov 17, 2022 •

edited

Loading

xinbenlv Jan 10, 2023 •

edited

Loading